﻿/*
 * Copyright (c) 2015-2016 Constantijn Evenhuis (blueprints@const.nl)
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
using Blueprints.Editing;
using System.Collections.Generic;

namespace Blueprints.Validation
{
    /// <summary>
    /// A validated property.
    /// </summary>
    public interface IValidatedProperty
    {
        /// <summary>
        /// Gets the name of the property.
        /// </summary>
        string Name { get; }

        /// <summary>
        /// Gets whether this is a required property.
        /// </summary>
        bool IsRequired { get; }

        /// <summary>
        /// Gets the property type.
        /// </summary>
        string Type { get; }

        /// <summary>
        /// Gets an indication of how this property should be edited.
        /// </summary>
        EditType EditType { get; }

        /// <summary>
        /// Gets the available values for this property, if it is a value type.
        /// </summary>
        IReadOnlyDictionary<ulong, string> AvailableValues { get; }

        /// <summary>
        /// Gets the node containing the property value, or null if the property does not have a value.
        /// </summary>
        IValidatedNode Node { get; }
    }
}